=========================================================================
ISTRUZIONI e SPECIFICHE per il PRIMO FRAMMENTO del PROGETTO di LabSO 09/10
========================================================================

Il progetto MSG e' suddiviso in  tre frammenti.
Il primo e' descritto in questo README.

Il primo frammento del progetto prevede l'implementazione di una
libreria che realizza liste e tabelle hash generiche che saranno utilizzate 
da client e server nel corso del progetto .


Questo primo frammento e' realizzabile usando esclusivamente C sequenziale, 
prerequisito del corso.


------------------------------------------------
Estrarre il materiale dal KIT di progetto
------------------------------------------------
Creare una directory temporanea, copiare lsoMSG_kitf1.tar  
nella directory e spostarsi nella directory appena creata. Es.

$$ mkdir Frammento1
$$ mv lsoMSG_kitf1.tar Frammento1
$$ cd Frammento1

S-tarare i file del primo kit con

$$ tar xvf lsoMSG_kitf1.tar 

questa operazione crea nella directory corrente una directory "MSG" che
contiene le seguenti sottodirectory:

$$ ls MSG
doc/  lib/  src/ 

doc/ contiene i file di configurazione e la documentazione formato doxygen
lib/ contiene le librerie
src/ contiene sorgenti, header, Makefile


========================================================================
ISTRUZIONI per la realizzazione della libreria 
========================================================================

La libreria prevede la realizzazione di due strutture: 
una lista ed una hash table. Le strutture sono "generiche" in quanto 
sono utilizzabili per memorizzare coppie (chiave,payload) di qualsiasi tipo.

Il kit fornisce due programmi di test per verificare il funzionamento della
libreria: 

src/test-genList.c
src/test-genHash.c

I test possono essere invocati con "make test11" e "make test12" 
rispettivamente dalla directory src.

------------------------------------------------------------------
File contenuti in src
------------------------------------------------------------------

$$ ls src/

gruppo-check.pl   README-1
gruppo.txt        genHash.h 
genList.h	  test-genList.c
Makefile	  test-genHash.c	  
README.doxygen

-----------------------------------------------
Descrizione del contenuto dei file 
-----------------------------------------------

README-1		: questo file


gruppo-check.pl		: uno script Perl che controlla il formato del file
			  gruppo.txt prima di effettuare la consegna
			  (NON MODIFICARE)

gruppo.txt		: un file di esempio di specifica del gruppo
			  (solo 1 studente per gruppo)
			  (deve essere aggiornato con i dati di chi consegna,
			  secondo il formato esemplificato)

test-genList.c	test-genHash.c 
			: programmi di test (NON MODIFICARE)

genList.h genHash.h
			: tipi e prototipi delle funzioni da realizzare
			  nel primo frammento
			  (si possono modificare solo aggiungendo
			  campi/definizioni/prototipi senza MODIFICARE/ELIMINARE
			  quelli gia' esistenti)

Makefile		: makefile per il test del frammento e la
			  consegna 
			  (MODIFICARE SOLO nelle parti richieste, vedi
			  commenti nel file)

README.doxygen		:  breve descrizione di doxygen, 
                             con rimandi ai siti rilevanti
			     per chi desidera usarlo per la
                             documentazione del codice (facoltativo)


------------------------------------------------
Cosa deve essere realizzato per il primo frammento :
------------------------------------------------

Il primo frammento prevede la realizzazione delle  funzioni i cui
proptotipi sono specificati in genList.h e genHash.h. 
Negli stessi file sono definiti e commentati i 
prototipi delle funzioni da realizzare.

I commenti nei file *.h spiegano le strutture dati da utilizzare
il comportamento delle varie funzioni, il significato dei parametri ed
i valori ritornati. La sintassi utilizzata e' quella di doxygen, un tool per
la creazione della documentazione 'tipo javadoc' comunemente utilizzato.
Chi vuole utilizzarlo per la produzione della documentazione puo' leggere
il README.doxygen.

Per generare la documentazione html dei file contenuti nel kit basta invocare

  bash:~$ make docu

e poi visualizzare il file ../doc/html/index.html con un browser.

Le funzioni definite in genList.h vengono naturalmente utilizzate
nella realizzazione della tabella hash definita in genHash.h.
E' quindi ragionevole *prima* realizzare
le funzioni in genList.h in un corrispondente "genList.c" e testarle.
Quando siamo ragionevolmente convinti della correttezza passare
alla realizzazione delle funzioni in genHash.h.

Le funzioni definite in un dato file XXX.h possono essere realizzate
usando un singolo file (in questo caso PER CONVENZIONE il file viene
chiamato XXX.c) o in piu' file (di cui uno e' comunque XXX.c).
In ogni caso il Makefile deve essere esteso con i target
corrispondenti a i moduli oggetti di tutti i file "*.c" realizzati.

Inoltre, il Makefile contiene una variabile 
FILE_DA_CONSEGNARE1
che deve contenere **tutti i file che lo studente intende consegnare
per il primo frammento**.

------------------
Come procedere :
-----------------

0) leggere attentamente il README e capire il funzionamento il codice fornito
   dai docenti 

1) analizzare accuratamente i file di test per capire il tipo di test
   effettuati 

2) implementare le funzioni richieste in uno o piu' file
   ed effettuare testing preliminare utilizzando un main() sviluppato 
   allo scopo

3) testare il software complessivo con i test forniti dai
  docenti. E' necessario
  prima settare la variabile di 
  ambiente MALLOC_TRACE in modo che contenga "./.mtrace" e poi
  procedere al test invocando i target opportuni

       bash:~$ export MALLOC_TRACE="./.mtrace"
       bash:~$ make test11
       bash:~$ make test12

  NOTA: (1) tutti i file sviluppati per la soluzione si devono trovare nella
  directory src/
  (2) E' importante che il test fornito dai docenti venga effettuato solo su
  un programma gia' funzionante altrimenti i risultati possono essere di
  difficile interpretazione, fuorvianti o inutili.

4) preparare la documentazione: ovvero commentare adeguatamente il/i file che
   contengono la soluzione  ed inserire una intestazione contenente il nome
   dello sviluppatore ed una dichiarazione di originalita' 

   /** \file pippo.c
       \author Nino Bixio
     Si dichiara che il contenuto di questo file e' in ogni sua parte opera
     originale dell' autore.  */

     Non e' richiesto di preparare anche la documentazione formato
     doxygen. Chi volesse farlo e' invitato a leggere il  README.doxigen.

6) aggiornare il file "gruppo.txt" con nome e dati

7) consegnare il file ESCLUSIVAMENTE eseguendo

      bash:~$ make consegna1

   e seguendo le istruzioni. Anche in questo caso occorre  che la variabile
   MALLOC_TRACE sia settata  a "./.mtrace".
   Per la consegna e' necessaria l'utility "mpack" installata solo nelle
   macchine dei laboratori H, M ed I. Per consegne da altre macchine e'
   possibile scaricare il binario di 'mpack' dal sito del corso oppure
   semplicemente allegare il tar file creato dal make consegna ad un
   normale messaggio di mail con subject "lso10: consegna primo
   frammento".

   Tutte le consegne verranno confermate con un messaggio entro 2/3
   giorni. In caso questo non si verifichi contattare il docente.
   

---------------------------------------
 NOTE IMPORTANTI: LEGGERE ATTENTAMENTE
---------------------------------------

1) gli eleborati non consegnati con "make consegna1" o contenenti un tar non
creato da "make consegna1" non verranno accettati

2) tutti gli elaborati verranno confrontati fra di loro con tool automatici
   per stabilire eventali situazioni di PLAGIO. Se tali situazioni si
   verificheranno *tutti* gli elaborato coinvolti verranno annullati con
   conseguente perdita del bonus. 

3) Tutti gli studenti coinvolti in un episodio di PLAGIO comprovato dovranno
   re-implementare il frammento incriminato e saranno sottoposti ad una prova
   orale supplementare. In caso di recidive verranno esclusi dalla
   possibilita' di sostenere l'esame per TUTTO IL RESTO DELL'ANNO ACCADEMICO
   IN CORSO.

4) Chi in sede di orale risulta palesemente non essere l'autore del software
   consegnato in uno dei frammenti verra' escluso dalla possibilita' di
   sostenere l'esame per TUTTO IL RESTO DELL'ANNO ACCADEMICO IN CORSO.

5) Tutti i comportamenti scorretti ai punti 3 e 4 verranno segnalati
   ufficialmente al presidente del corso di laurea, che si riserva di
   decidere azioni disciplinari supplementari a quelle sopra descritte.

----------------------------
 VALUTAZIONE DEL FRAMMENTO:
----------------------------

Gli studenti che consegnano una versione funzionante e ragionevolmente
corretta del frammento entro la data di scadenza accumulano un bonus di 2
punti che verra' sommato al voto finale (vedi lucidi lezioni ed
esercitazioni).

La qualita' del codice consegnato per il primo frammento verra' valutata come
parte del progetto finale e contribuira' alla votazione assegnata al progetto.
Eventuali caratteristiche in piu' rispetto a quelle strettamente richieste
dalle specifiche date qua (es. documentazione HTML o in altri
formati, funzionalita' in piu') verranno valutate in questa sede.
